# Facts (/docs/core-concepts/facts)
**Facts** are canonical knowledge-graph entities: an organization, an investment round, or an acquisition. They have stable IDs, dates, amounts, and parties — not document text.
Use facts when you need **deal or company structure** (who invested, how much, when a company was founded). Use [proof points](/docs/core-concepts/proof-points) when you need the articles or filings that mention those entities.
Connect exposes `POST /facts/{organizations|investments|acquisitions}/search` and `/time-series`. See the [Facts](/docs/facts) guides.
How organizations are resolved into the graph is covered in [Organizations](/docs/core-concepts/organizations).
# Indicators (/docs/core-concepts/indicators)
**Indicators** in Connect are **computed metrics** over topics — not the document or deal APIs.
Today that means [Industry TSI](/docs/indicators/industry-tsi): an industry-level trend strength time series. Call `GET /indicators/industry-tsi/time-series`.
Older `/indicators/*` routes for patents, news, grants, investments, and similar are **deprecated**. They still work, but new integrations should use:
* [Proof points](/docs/core-concepts/proof-points) — indexed documents (`POST /proof-points/...`)
* [Facts](/docs/core-concepts/facts) — knowledge-graph organizations, investments, and acquisitions (`POST /facts/...`)
* [Manifestations](/docs/core-concepts/manifestations) — grouped events (`POST /manifestations/search`)
The [Release 0.0.1](/docs/release-notes/0.0.1) note has the full endpoint map and a copy-paste LLM prompt to migrate a codebase. Deprecated guides remain under [Deprecated](/docs/deprecated/patent).
# Manifestations (/docs/core-concepts/manifestations)
A **manifestation** is a grouped event — a product launch, partnership, patent cluster, funding round, and so on — not a single raw document and not a single graph node. Trendtracker builds manifestations from [proof points](/docs/proof-points) and [facts](/docs/facts), then returns one row with supporting `references`.
This is the replacement for deprecated partnership and product-launch **indicator** endpoints.
**Endpoint:** `POST /manifestations/search` — [playground](/docs/api-reference/endpoints/search_manifestations_manifestations_search_post)
## Types [#types]
| Type | Source |
| ------------------- | ---------------------- |
| `news-event` | Proof points |
| `patent` | Proof points |
| `research-article` | Proof points |
| `consulting-report` | Proof points |
| `earnings-call` | Proof points |
| `product-launch` | Proof points |
| `partnership` | Proof points |
| `organization` | Facts |
| `investment` | Proof points and facts |
| `acquisition` | Proof points and facts |
Pass `types` to limit the mix. Omit it to search across types.
Investment and acquisition manifestations can attach **both** document proof points and knowledge-graph facts on the same row (`references` may mix `proof_point` and `fact`).
## Typical Questions [#typical-questions]
* What product launches and partnerships happened around this topic last year?
* Which events are corroborated by more than one source?
* What investments and acquisitions sit next to the document-based events?
## Paging [#paging]
Manifestations use **cursor** paging, not `skip`:
* `take` — page size, max 100 (default 100)
* `cursor` — opaque token from the previous response (`cursor` is `null` when there is no next page)
Shared proof-point filters also apply: `query`, `topicIds`, `organizationIds`, `languages`, `sourceIds`, `start` / `end`.
## Query [#query]
`query` uses the same Lucene-lite language as [proof points](/docs/proof-points), but only when `types` is restricted to proof-point types (`news-event`, `patent`, `research-article`, `consulting-report`, `earnings-call`, `product-launch`, `partnership`).
Fielded or boolean `query` (`title:`, `AND` / `OR` / `NOT`, grouping) is rejected when `types` is omitted or includes fact-backed types (`organization`, `investment`, `acquisition`). In those cases use a simple string: `lithium`, `solid state battery`, or `"solid state battery"`.
[Facts](/docs/facts) endpoints keep a plain organization-label `query` (max 50 characters). They do not accept this language.
## Type-specific nested filters [#type-specific-nested-filters]
| Field | Applies to | Notes |
| ------------------------------------------ | ---------------- | ------------------------------------------------------------- |
| `newsEventFilter.minUniqueSourceCount` | `news-event` | Ignored for patents and research articles |
| `productLaunchFilter.minUniqueSourceCount` | `product-launch` | Same |
| `partnershipFilter.minUniqueSourceCount` | `partnership` | Minimum distinct sources |
| `organizationFilter` | `organization` | Same shape as [organization facts](/docs/facts/organizations) |
| `investmentFilter` | `investment` | Same shape as [investment facts](/docs/facts/investments) |
| `acquisitionFilter` | `acquisition` | Same shape as [acquisition facts](/docs/facts/acquisitions) |
## Request Pattern [#request-pattern]
```json
{
"types": ["partnership", "product-launch"],
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"start": "2023-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 50,
"partnershipFilter": {
"minUniqueSourceCount": 2
},
"productLaunchFilter": {
"minUniqueSourceCount": 2
}
}
```
Follow-up page:
```json
{
"types": ["partnership", "product-launch"],
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"cursor": "opaque-cursor-from-previous-response",
"take": 50
}
```
## Response Notes [#response-notes]
Each manifestation can include:
* `type`
* `title`
* `start` / `end`
* `companies`, `products`
* `amount`
* `uniqueSourceCount`
* `references` — each has `type` (`proof_point` or `fact`), `id`, and either `proofPointType` or `factType`
The page object is `{ "data": [...], "cursor": "..." }`.
# Organizations (/docs/core-concepts/organizations)
Trendtracker treats **organizations** as first-class entities: companies, research institutions, and other legal or operational units that show up in investments, patents, news, and other signals. They are not just labels in text—they are **stable records** in a **knowledge graph** that we connect to the rest of the platform.
## A graph built on trusted registries [#a-graph-built-on-trusted-registries]
The graph is grounded in large, public **reference databases** that define who an organization is in the real world. We integrate and reconcile identifiers and attributes from sources such as:
* **GLEIF** (Global Legal Entity Identifier Foundation) — legal entity identifiers and corporate structure where available.
* **Wikidata** — rich linked open data and cross-references to many other systems.
* **Research Organization Registry (ROR)** — persistent identifiers and metadata for research-performing organizations.
Those foundations give us shared IDs, hierarchies, and aliases so that “the same organization” can be recognized consistently across documents, filings, and datasets—even when the surface text differs (subsidiary names, abbreviations, rebrands).
## Linking your data to the graph: Entity resolution [#linking-your-data-to-the-graph-entity-resolution]
The content Trendtracker ingests and processes (articles, announcements, regulatory text, and more) rarely arrives with a clean, canonical org ID. We run **entity resolution**: matching mentions and records in that content to the right graph nodes—using names, context, known relationships, and confidence from the knowledge we have already ingested.
Once resolved, activity and attributes can be **linked together**: the same organization can be seen across topics, time, and datasets without fragmenting into duplicate or ambiguous strings. That is what makes organization-centric analysis—who is active in a space, who is investing, who appears in a deal—**composable** with the rest of Connect (topics, [facts](./facts), [proof points](./proof-points), and [manifestations](./manifestations)).
Search and chart organizations as knowledge-graph records with `POST /facts/organizations/search` and `POST /facts/organizations/time-series`. See [Organization facts](/docs/facts/organizations).
# Proof points (/docs/core-concepts/proof-points)
**Proof points** are the documents behind a signal: patents, news, research articles, earnings-call transcripts, PDFs, and grant projects. They live in document indexes, not the knowledge graph.
Use them when you need the **underlying record** — a URL, title, summary, or organization mention — rather than a pre-grouped event or a canonical deal.
Connect exposes each dataset as `POST /proof-points/{type}/search`, `/time-series`, and `/correlation-matrix`. See the [Proof points](/docs/proof-points) guides for request shapes.
Related:
* [Facts](/docs/core-concepts/facts) — structured organizations and deals
* [Manifestations](/docs/core-concepts/manifestations) — events grouped from proof points and facts
# Topics (/docs/core-concepts/topics)
A **topic** is a concept Trendtracker tracks in its knowledge graph: technologies, markets, materials, and risk themes you can measure and compare. Examples include:
* precision fermentation
* edge AI
* solid-state batteries
* supply chain disruption (as a **risk** topic)
Most workflows start with topic discovery, then pass **topic IDs** from the responses into [proof points](./proof-points), [facts](./facts), [manifestations](./manifestations), or [Industry TSI](./indicators).
## Topic hierarchy [#topic-hierarchy]
Topics are organized in a **parent–child** hierarchy. A child is a narrower concept under a broader parent; both are topics with their own IDs. For example, *Generative AI* is a child of *artificial intelligence*. When you search or browse, you work with the same topic model—use the returned IDs to query related topics or to scope proof points, facts, and manifestations.
## Topic sets [#topic-sets]
Topics are grouped thematically in **topic sets** (for example, a set may group related technologies or a risk domain). A single topic can belong to one or more topic sets. Topic set IDs are useful to **scope** a topic search so results stay within a theme you care about.
## How to use topics (typical flow) [#how-to-use-topics-typical-flow]
1. **Find a topic set (optional but useful for scoping):** call `GET /topic-sets` with a `query` that matches the area you care about, and copy the `id` of a relevant topic set from the response.
2. **Search topics, including “risks”:** call `GET /topics` with `query=risks` to surface risk-related topics. Add `topicSetIds` (one or more IDs from step 1) to limit results to that set.
3. **Go deeper:** use a topic’s `id` with `GET /topics/{topic_id}/related` for adjacency in the graph, or pass those **topic IDs** as `topicIds` in proof-point, fact, and manifestation request bodies.
## Recommended endpoints [#recommended-endpoints]
* **List or search topic sets** — `GET /topic-sets` (use the `query` parameter to find sets by keyword).
* **Search topics by keyword** — `GET /topics` with `query`. Add `topicSetIds` to filter results to specific topic sets. Use `skip` and `take` for paging.
* **Related topics** — `GET /topics/{topic_id}/related` to expand context around a topic you already have.
* **Downstream data** — reuse one or more **topic IDs** as `topicIds` in [proof points](/docs/proof-points), [facts](/docs/facts), and [manifestations](/docs/core-concepts/manifestations).
# Acquisitions (/docs/facts/acquisitions)
Acquisition facts are structured M\&A events: acquirer, acquiree, date, type, and amount.
**Endpoints:**
* `POST /facts/acquisitions/search` — [playground](/docs/api-reference/endpoints/search_acquisitions_facts_acquisitions_search_post)
* `POST /facts/acquisitions/time-series` — [playground](/docs/api-reference/endpoints/acquisitions_time_series_facts_acquisitions_time_series_post)
## Typical Questions [#typical-questions]
* Is the market consolidating around this trend?
* Are acquisitions becoming larger or more frequent?
* Which exact deals are driving movement?
## Type-specific filters [#type-specific-filters]
On top of the [shared fact fields](/docs/facts):
* `topicLink` — `acquirer`, `acquiree`, or `both` (default)
* `minValue` / `maxValue` — deal amount
* `acquisitionTypes` — `acquisition`, `merge`, `acquihire`, `leveraged_buyout`, `management_buyout`
* `acquirerEmployeesCounts` / `acquireeEmployeesCounts`
* `sortColumn` — `acquired_on` (default), `amount`, `acquirer`, `acquiree`, or `certainty`
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"topicLink": "acquiree",
"acquisitionTypes": ["acquisition", "merge"],
"start": "2020-01-01",
"end": "2024-12-31",
"take": 25,
"sortColumn": "acquired_on",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "year",
"start": "2015-01-01",
"end": "2024-12-31"
}
```
## Response Notes [#response-notes]
Each acquisition includes `id`, `acquisitionType`, `acquiredOn`, `amount`, `acquirer`, `acquiree`, and `certainty`. Time series returns `labels`, `counts`, and `amounts`.
# Facts (/docs/facts)
**Facts** are stable knowledge-graph entities: companies, investment rounds, and acquisitions. They are not documents. Use them when you need deal amounts, founding dates, or canonical organization IDs.
For the documents that mention those entities, use [Proof points](/docs/proof-points). For grouped events that mix documents and facts, use [Manifestations](/docs/core-concepts/manifestations).
Each fact type exposes:
* **Search** — a page of records (`skip` / `take`, max 100)
* **Time series** — counts per bucket; investments and acquisitions also return `amounts`
All of these are `POST` with a JSON body. Date filters use calendar dates (`YYYY-MM-DD`), not datetimes.
## Shared request fields [#shared-request-fields]
| Field | Purpose |
| ------------------------------ | ----------------------------------------------------------------------- |
| `topicIds` / `organizationIds` | Scope to topics and organizations |
| `query` | Optional free-text over organization labels (max 50 characters) |
| `certainty` | Topic-link confidence threshold, 0–1. Only valid when `topicIds` is set |
| `start` / `end` | Inclusive date window |
| `skip` / `take` | Offset paging; `take` max 100 |
| `sortDirection` | `desc` (default) or `asc` |
| `resolution` | Time series only: `month`, `quarter`, or `year` (default `year`) |
## Entity types [#entity-types]
* [Organizations](/docs/facts/organizations)
* [Investments](/docs/facts/investments)
* [Acquisitions](/docs/facts/acquisitions)
Interactive schemas live in the [API reference](/docs/api-reference).
# Investments (/docs/facts/investments)
Investment facts are structured funding events: investors, investee, announced date, type, and amount.
**Endpoints:**
* `POST /facts/investments/search` — [playground](/docs/api-reference/endpoints/search_investments_facts_investments_search_post)
* `POST /facts/investments/time-series` — [playground](/docs/api-reference/endpoints/investments_time_series_facts_investments_time_series_post)
## Typical Questions [#typical-questions]
* Is investor attention accelerating for this trend?
* What funding types and company sizes appear?
* Which concrete rounds explain the curve?
## Type-specific filters [#type-specific-filters]
On top of the [shared fact fields](/docs/facts):
* `topicLink` — `investor`, `investee`, or `both` (default)
* `minValue` / `maxValue` — deal amount
* `investmentTypes` — for example `seed`, `series_a`, `grant`
* `investorEmployeesCounts` / `investeeEmployeesCounts`
* `sortColumn` — `announced_on` (default), `amount`, `investee`, or `certainty`
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"topicLink": "investee",
"investmentTypes": ["seed", "series_a"],
"minValue": 1000000,
"start": "2022-01-01",
"end": "2024-12-31",
"take": 25,
"sortColumn": "announced_on",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "quarter",
"start": "2020-01-01",
"end": "2024-12-31"
}
```
## Response Notes [#response-notes]
Each investment includes `id`, `investmentType`, `announcedOn`, `amount`, `investors`, `investee`, and `certainty`. Time series returns `labels`, `counts`, and `amounts`.
# Organizations (/docs/facts/organizations)
Organization facts are canonical company and institution records from the knowledge graph. See also [how organizations are modeled](/docs/core-concepts/organizations).
**Endpoints:**
* `POST /facts/organizations/search` — [playground](/docs/api-reference/endpoints/search_organizations_facts_organizations_search_post)
* `POST /facts/organizations/time-series` — [playground](/docs/api-reference/endpoints/organizations_time_series_facts_organizations_time_series_post)
Time series buckets use **founded-on** dates.
## Typical Questions [#typical-questions]
* Which companies are present for this topic?
* Is new company formation accelerating?
* Which organizations have the strongest topic link (`certainty`)?
## Type-specific filters [#type-specific-filters]
On top of the [shared fact fields](/docs/facts):
* `employeesCounts` — size buckets such as `1-10`, `51-100`, `10001+`
* `sortColumn` — `name` (default), `founded_on`, or `certainty`
* `fields` — response field selection (defaults include `id`, `name`, `foundedOn`, `certainty`, `employeesCount`)
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"query": "northvolt",
"certainty": 0.5,
"employeesCounts": ["51-100", "101-250"],
"take": 25,
"sortColumn": "name",
"sortDirection": "asc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "year",
"start": "2010-01-01",
"end": "2024-12-31"
}
```
## Response Notes [#response-notes]
Each organization includes `id`, `name`, `foundedOn`, `certainty`, and `employeesCount` unless you narrow `fields`. Time series returns `labels` and `counts`. Organizations without `foundedOn` are counted in `withoutLabel`.
## Validation Notes [#validation-notes]
* `certainty` greater than `0` requires `topicIds`.
# Acquisitions (/docs/deprecated/acquisitions)
These indicator endpoints are deprecated. Use [Acquisitions](/docs/facts/acquisitions) instead: `POST /facts/acquisitions/search` and `POST /facts/acquisitions/time-series` (POST JSON body, not GET query params). `summary-statistics` has no replacement. See [Release 0.0.1](/docs/release-notes/0.0.1).
Acquisition indicators are available through:
* `GET /indicators/acquisitions/summary-statistics`
* `GET /indicators/acquisitions/time-series`
* `GET /indicators/acquisitions/proof-points`
## Typical Questions [#typical-questions]
* Is the market consolidating around this trend?
* Are acquisitions becoming larger or more frequent?
* Which exact deals are driving movement?
# Earnings calls (/docs/deprecated/earnings-calls)
These indicator endpoints are deprecated. Use [Earnings calls](/docs/proof-points/earnings-calls) instead: `POST /proof-points/earnings-calls/search` and `POST /proof-points/earnings-calls/time-series`. See [Release 0.0.1](/docs/release-notes/0.0.1) for the full mapping and request-body changes.
Earnings call indicators are built from indexed earnings-call documents and expose:
* `POST /indicators/earnings-calls/proofpoints`
* `POST /indicators/earnings-calls/time-series`
Date filters apply to the document **published date**. Filter by topic, organization, and other nested index search clauses the same way as patents and research articles.
## Typical Questions [#typical-questions]
* Which topics are showing rising earnings-call discussion around this trend?
* What are representative earnings-call documents for selected organizations?
* How does earnings-call volume evolve month over month for a topic or company?
# Grants (/docs/deprecated/grants)
These indicator endpoints are deprecated. Use [Projects](/docs/proof-points/projects) instead: `POST /proof-points/projects/search` and `POST /proof-points/projects/time-series`. The nested `interval_overlap` filter is not available on the replacement — `start` and `end` there are published-date bounds. See [Release 0.0.1](/docs/release-notes/0.0.1) for the full mapping.
Grant indicators are available through:
* `POST /indicators/grants/proofpoints`
* `POST /indicators/grants/time-series`
## What Is Different About Grants [#what-is-different-about-grants]
Grants use project intervals (`start_date`, `end_date`) rather than publication dates.
* Use `interval_overlap` in `query` to filter projects by date overlap.
* For time series, provide `start` and `end` to define the chart window.
* `time-series` returns both project counts and `amount` (capital exposure) per bucket.
## Typical Questions [#typical-questions]
* Which grants are active in this topic and period?
* Is active project volume increasing or declining across the chosen window?
* How much total project capital is exposed month-by-month?
## Request Patterns [#request-patterns]
### Proofpoints [#proofpoints]
Use the same nested query style as other document indicators, but with `interval_overlap` for project dates.
```json
{
"query": {
"type": "and",
"clauses": [
{
"type": "query",
"query": "battery recycling"
},
{
"type": "interval_overlap",
"start": "2022-01-01",
"end": "2024-12-31"
}
]
},
"take": 25,
"skip": 0,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time Series [#time-series]
`start` and `end` define bucket generation for the output series.
```json
{
"resolution": "month",
"start": "2022-01-01",
"end": "2024-12-31",
"query": {
"type": "interval_overlap",
"start": "2022-01-01",
"end": "2024-12-31"
}
}
```
## Response Notes [#response-notes]
* `labels`: bucket labels at the selected resolution.
* `counts`: number of active overlapping projects in each bucket.
* `amount`: rounded, time-weighted capital exposure per bucket.
* Uses project `total_cost`.
* Falls back to `cordis_ec_contribution` when `total_cost` is missing or `0`.
## Validation Notes [#validation-notes]
* `DateFilter` is not supported for grants. Use `interval_overlap` instead.
* `start` must be on or before `end`.
* Score-weighted time series options are not supported on grant time series.
# Investments (/docs/deprecated/investments)
These indicator endpoints are deprecated. Use [Investments](/docs/facts/investments) instead: `POST /facts/investments/search` and `POST /facts/investments/time-series` (POST JSON body, not GET query params). `summary-statistics` has no replacement. See [Release 0.0.1](/docs/release-notes/0.0.1).
Investment indicators are available through:
* `GET /indicators/investments/summary-statistics`
* `GET /indicators/investments/time-series`
* `GET /indicators/investments/proof-points`
## Typical Questions [#typical-questions]
* Is investor attention accelerating for this trend?
* What funding profiles appear (type, company size, timing)?
* Which concrete investment events explain the curve?
# News articles (/docs/deprecated/news-articles)
These indicator endpoints are deprecated. Use [News articles](/docs/proof-points/news-articles) instead: `POST /proof-points/news-articles/search` and `POST /proof-points/news-articles/time-series`. See [Release 0.0.1](/docs/release-notes/0.0.1) for the full mapping and request-body changes.
News article indicators surface documents from all configured article indexes—news coverage and other article-type sources tied to your topics and organizations. Unlike partnership or product-launch indicators, this dataset is not restricted to relation-extraction labels; it returns the full article corpus matching your filters.
**Endpoints:**
* `POST /indicators/news-articles/proofpoints`
* `POST /indicators/news-articles/time-series`
## Typical Questions [#typical-questions]
* How is media and news coverage evolving around this trend?
* Which articles mention organizations in my scope for selected topics?
* How does article volume change month over month for a topic or language filter?
# Organizations (/docs/deprecated/organizations)
These indicator endpoints are deprecated. Use [Organization facts](/docs/facts/organizations) instead: `POST /facts/organizations/search` and `POST /facts/organizations/time-series` (POST JSON body, not GET query params). `summary-statistics` has no replacement. See [Release 0.0.1](/docs/release-notes/0.0.1).
Organization indicators are available through:
* `GET /indicators/organizations/summary-statistics`
* `GET /indicators/organizations/time-series`
* `GET /indicators/organizations/proof-points`
## Typical Questions [#typical-questions]
* How broad is company participation in this trend?
* Is organization activity rising or flattening?
* Which organizations are representative proof points?
# Partnerships (/docs/deprecated/partnerships)
These indicator endpoints are deprecated. Prefer [Manifestations](/docs/core-concepts/manifestations) with `types: ["partnership"]` (`POST /manifestations/search`). For raw articles, use [News articles](/docs/proof-points/news-articles) with `mentionsEvents: ["partnership"]`. See [Release 0.0.1](/docs/release-notes/0.0.1).
Partnership indicators surface documents containing partnerships.
**Endpoints:**
* `POST /indicators/partnerships/proofpoints`
* `POST /indicators/partnerships/time-series`
## Typical Questions [#typical-questions]
* Where are startup partnerships showing up in the narrative around this trend?
* How does partnership-related volume evolve month over month?
* Which proof-point articles illustrate ecosystem collaboration for selected topics?
# Patent (/docs/deprecated/patent)
These indicator endpoints are deprecated. Use [Patents](/docs/proof-points/patents) instead: `POST /proof-points/patents/search` and `POST /proof-points/patents/time-series`. See [Release 0.0.1](/docs/release-notes/0.0.1) for the full mapping and request-body changes.
Patent indicators are built from indexed patent documents and expose:
* `POST /indicators/patents/proofpoints`
* `POST /indicators/patents/time-series`
## Typical Questions [#typical-questions]
* Which topics are showing rising patent momentum?
* What are representative patent examples for this trend?
* Is activity broad-based or concentrated in a few clusters?
# Product launches (/docs/deprecated/product-launches)
These indicator endpoints are deprecated. Prefer [Manifestations](/docs/core-concepts/manifestations) with `types: ["product-launch"]` (`POST /manifestations/search`). For raw articles, use [News articles](/docs/proof-points/news-articles) with `mentionsEvents: ["product-launch"]`. See [Release 0.0.1](/docs/release-notes/0.0.1).
Product launch indicators surface documents containing startup product launch announcements.
**Endpoints:**
* `POST /indicators/product-launches/proofpoints`
* `POST /indicators/product-launches/time-series`
## Typical Questions [#typical-questions]
* Where are startup product launches showing up in the narrative around this trend?
* How does product-launch-related volume evolve month over month?
* Which proof-point articles capture new product announcements for selected topics?
# Research Journals (/docs/deprecated/research-journals)
These indicator endpoints are deprecated. Use [Research articles](/docs/proof-points/research-articles) instead: `POST /proof-points/research-articles/search` and `POST /proof-points/research-articles/time-series`. See [Release 0.0.1](/docs/release-notes/0.0.1) for the full mapping and request-body changes.
Research-journal indicators are exposed via:
* `POST /indicators/research-articles/proofpoints`
* `POST /indicators/research-articles/time-series`
## Typical Questions [#typical-questions]
* Is this trend still primarily academic, or already commercial?
* Which topics are gaining scientific attention fastest?
* What publications support a trend narrative?
# Industry TSI (/docs/indicators/industry-tsi)
Industry TSI compares industry-level trend strength over time for benchmarking.
Available endpoints:
* `GET /indicators/industry-tsi/time-series` — [playground](/docs/api-reference/endpoints/get_industry_tsi_time_series_indicators_industry_tsi_time_series_get)
* `GET /industries` — search industries by keyword when selecting an industry filter — [playground](/docs/api-reference/endpoints/search_industries_industries_get)
This is a computed indicator. Document search, deals, and grouped events use [Proof points](/docs/proof-points), [Facts](/docs/facts), and [Manifestations](/docs/core-concepts/manifestations).
## Typical Questions [#typical-questions]
* How does trend strength move for this industry versus others?
* Where does this sector sit relative to peers for the selected period?
# Authentication (/docs/introduction/authentication)
The Connect API supports API-key authentication using the `x-api-key` header.
If you do not have an API key yet, ask the [Trendtracker team](mailto:mathias.colpaert@trendtracker.ai) for access.
## Required Header [#required-header]
```http
x-api-key: YOUR_API_KEY
```
## Set Your API Key Locally [#set-your-api-key-locally]
Use an environment variable so you do not hardcode secrets in scripts or source files.
```bash
export TT_API_KEY="your_api_key_here"
```
To persist it in zsh, add the same line to your `~/.zshrc` and restart your shell.
Security best practices:
* Store API keys in environment variables or a secret manager.
* Never commit API keys to git repositories.
* Never include API keys in URL query parameters.
## Verify Authentication [#verify-authentication]
Run a simple authenticated request:
```bash
curl -s "https://connect-api.trendtracker.ai/topics?query=aviation&take=1" \
-H "x-api-key: $TT_API_KEY"
```
If authentication is configured correctly, the API returns a `200 OK` response with JSON content.
## JavaScript Example [#javascript-example]
```js
const response = await fetch(
"https://connect-api.trendtracker.ai/topics?query=aviation&take=10",
{
headers: {
"x-api-key": process.env.TT_API_KEY,
},
}
);
const data = await response.json();
console.log(data);
```
## Common Mistakes [#common-mistakes]
* Missing `x-api-key` header -> request is rejected.
* Typo in header name (`x_api_key`, `api-key`, etc.) -> request is rejected.
* Sending key in query params -> unsupported and insecure.
* Exposing your API key in frontend code -> insecure. Keep requests server-side.
# Welcome (/docs/introduction/welcome)
[Trendtracker](https://trendtracker.ai) helps teams spot meaningful shifts in technology and markets earlier.
The [Connect API](https://connect-api.trendtracker.ai/docs) lets you query that intelligence directly from your applications.
By the end of this quickstart, you will make one authenticated request and retrieve topics you can explore further.
## Getting Started [#getting-started]
1. Ask the [Trendtracker team](mailto:mathias.colpaert@trendtracker.ai) for an API key.
2. Store your key in an environment variable, then follow the [authentication](./authentication) guide to send it correctly.
3. Search [topics](../core-concepts/topics) with `GET /topics`.
4. Pass those topic IDs into [proof points](../core-concepts/proof-points), [facts](../core-concepts/facts), or [manifestations](../core-concepts/manifestations).
Already calling `/indicators/*` (other than Industry TSI)? Start with [Release 0.0.1](../release-notes/0.0.1).
## Learn More [#learn-more]
# Correlation matrix (/docs/proof-points/correlation-matrix)
A correlation matrix counts how often row entities and column entities appear together in matching proof points. Use it to see which organizations cluster around which topics, or how two topic groups overlap in the same documents.
**Endpoints:**
* `POST /proof-points/correlation-matrix` — all document types — [playground](/docs/api-reference/endpoints/proof_points_correlation_matrix_proof_points_correlation_matrix_post)
* `POST /proof-points/news-articles/correlation-matrix`
* `POST /proof-points/patents/correlation-matrix`
* `POST /proof-points/research-articles/correlation-matrix`
* `POST /proof-points/earnings-calls/correlation-matrix`
* `POST /proof-points/pdfs/correlation-matrix`
* `POST /proof-points/projects/correlation-matrix`
Type-specific routes apply the same matrix request on one dataset. Shared proof-point filters (`query`, `topicIds`, `start` / `end`, and so on) still apply.
## Axes [#axes]
Each of `rows` and `cols` is:
| Field | Purpose |
| -------- | -------------------------------------------------------------------------------------------- |
| `kind` | `topic` or `organization` |
| `groups` | Non-empty list of UUID groups. Each inner list is **one bucket** (IDs in a group are OR-ed). |
## Request Pattern [#request-pattern]
```json
{
"start": "2023-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"rows": {
"kind": "topic",
"groups": [
["11111111-1111-1111-1111-111111111111"],
["22222222-2222-2222-2222-222222222222"]
]
},
"cols": {
"kind": "organization",
"groups": [
["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"],
["bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"]
]
}
}
```
## Validation Notes [#validation-notes]
* Every group must contain at least one UUID.
* Use the all-types route when you want a single matrix across datasets; use a type-specific route to isolate patents, news, or another corpus.
# Earnings calls (/docs/proof-points/earnings-calls)
Earnings-call proof points are transcripts and related documents. Date filters apply to **published date**.
**Endpoints:**
* `POST /proof-points/earnings-calls/search` — [playground](/docs/api-reference/endpoints/search_earnings_calls_proof_points_earnings_calls_search_post)
* `POST /proof-points/earnings-calls/time-series` — [playground](/docs/api-reference/endpoints/earnings_calls_time_series_proof_points_earnings_calls_time_series_post)
* `POST /proof-points/earnings-calls/correlation-matrix` — [playground](/docs/api-reference/endpoints/earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post)
## Typical Questions [#typical-questions]
* Which topics are showing rising earnings-call discussion?
* What are representative transcripts for selected organizations?
* How does earnings-call volume evolve month over month?
## Request Patterns [#request-patterns]
Uses the [shared proof-point fields](/docs/proof-points) only — no extra type-specific filters.
### Search [#search]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"organizationIds": ["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"],
"start": "2023-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 25,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "quarter",
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Results use the shared enriched-document shape (`title`, `summary`, `publishedAt`, `url`, `topics`, `orgNodes`). Time series returns `labels` and `counts`.
# Proof points (/docs/proof-points)
**Proof points** are the underlying records behind Trendtracker signals: patents, news articles, research papers, earnings-call transcripts, PDFs, and grant projects. They come from document indexes, not the knowledge graph.
Use proof points when you need **traceability**, citations, or document-level filters. For structured deals and company records, use [Facts](/docs/facts). For grouped real-world events assembled from both, use [Manifestations](/docs/core-concepts/manifestations).
Every proof-point dataset exposes the same three shapes:
* **Search** — a page of enriched documents (`skip` / `take`, max 100).
* **Time series** — counts (and sometimes amounts) per time bucket at a `resolution` of `day`, `week`, `month`, `quarter`, or `year`.
* **Correlation matrix** — co-occurrence of topics and/or organizations. See [Correlation matrix](/docs/proof-points/correlation-matrix).
All of these are `POST` with a JSON body. Date filters apply to **published date**.
## Shared request fields [#shared-request-fields]
| Field | Purpose |
| ------------------------------ | ---------------------------------------------------------------------- |
| `query` | Optional Lucene-lite text search (see below) |
| `topicIds` / `organizationIds` | Scope to topics and resolved organizations |
| `topicFields` | Document fields used for topic matching (default title, summary, body) |
| `languages` | ISO language codes |
| `sourceIds` | Restrict to specific indexed sources |
| `start` / `end` | Published-date window (ISO datetimes) |
| `skip` / `take` | Offset paging; `take` max 100 |
| `sortColumn` | `published_at` (default) or `score` |
| `sortDirection` | `desc` (default) or `asc` |
## Query syntax [#query-syntax]
`query` is a closed Lucene-lite expression over document text. Unprefixed words run a loose match on `title`, `summary`, and `body`. Use quotes for a phrase, `field:` to restrict a clause, and uppercase `AND` / `OR` / `NOT` (or `-term`) to combine them.
| Example | Meaning |
| ------------------------------------------------- | ------------------------------------------------------ |
| `lithium` | Loose match on title, summary, and body |
| `solid state battery` | One loose multi-word match (not an AND of three terms) |
| `"solid state battery"` | Phrase match on title, summary, and body |
| `title:lithium` | Loose match on title only |
| `title:"solid state battery"` | Phrase match on title |
| `title:(solid state battery)` | Loose multi-word match on title |
| `document:"quantum sensing"` | Phrase match on title, summary, and body |
| `title:"ssb" AND (body:lithium OR summary:anode)` | Boolean combination |
| `(foo OR bar) baz` | Implicit AND of already-delimited clauses |
Fields: `title`, `summary`, `body`, and `document` (all three). After `field:` use one token, one `"phrase"`, or `(...)`. `title:solid state` is rejected (a field prefix cannot be followed by extra bare tokens). Wildcards (`*`), fuzzy (`~`), and boost (`^`) are not supported. Lowercase `and` is a search token, not an operator. Unknown `foo:bar` is treated as a literal token so values like `covid-19` stay valid.
## Datasets [#datasets]
* [News articles](/docs/proof-points/news-articles) — media coverage; optional `mentionsEvents` for partnerships and product launches
* [Patents](/docs/proof-points/patents) — filings and grants
* [Research articles](/docs/proof-points/research-articles) — scientific publications
* [Earnings calls](/docs/proof-points/earnings-calls) — transcripts from finance sources
* [PDFs](/docs/proof-points/pdfs) — consulting reports and other PDF documents
* [Projects](/docs/proof-points/projects) — grant and R\&D projects (replaces grants indicators)
Interactive schemas live in the [API reference](/docs/api-reference).
# News articles (/docs/proof-points/news-articles)
News articles are the full article corpus — coverage and other article-type sources — without requiring a relation-extraction label. Use `mentionsEvents` when you only want articles that mention a product launch, partnership, investment, or acquisition.
**Endpoints:**
* `POST /proof-points/news-articles/search` — [playground](/docs/api-reference/endpoints/search_news_articles_proof_points_news_articles_search_post)
* `POST /proof-points/news-articles/time-series` — [playground](/docs/api-reference/endpoints/news_articles_time_series_proof_points_news_articles_time_series_post)
* `POST /proof-points/news-articles/correlation-matrix` — [playground](/docs/api-reference/endpoints/news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post)
For grouped partnership or product-launch events, prefer [Manifestations](/docs/core-concepts/manifestations).
## Typical Questions [#typical-questions]
* How is media coverage evolving around this trend?
* Which articles mention organizations in my scope?
* Which articles are labeled as product launches or partnerships?
## Type-specific filters [#type-specific-filters]
On top of the [shared proof-point fields](/docs/proof-points):
* `mentionsEvents` — `product-launch`, `partnership`, `investment`, `acquisition`
* `sourceIsPremium` — restrict to premium sources
* `sourceCountryIds` — source country UUIDs
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"query": "solid-state batteries",
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"start": "2023-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"mentionsEvents": ["product-launch"],
"take": 25,
"skip": 0,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "month",
"start": "2023-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Search returns a page of enriched documents: `title`, `summary`, `url`, `publishedAt`, `source`, `topics`, `orgNodes`, and related entity nodes. Time series returns `labels` and `counts` per bucket.
# Patents (/docs/proof-points/patents)
Patent proof points are built from indexed patent documents. Date filters apply to **published date**.
**Endpoints:**
* `POST /proof-points/patents/search` — [playground](/docs/api-reference/endpoints/search_patents_proof_points_patents_search_post)
* `POST /proof-points/patents/time-series` — [playground](/docs/api-reference/endpoints/patents_time_series_proof_points_patents_time_series_post)
* `POST /proof-points/patents/correlation-matrix` — [playground](/docs/api-reference/endpoints/patents_correlation_matrix_proof_points_patents_correlation_matrix_post)
## Typical Questions [#typical-questions]
* Which topics show rising patent momentum?
* What are representative patents for this trend?
* Is activity concentrated in a few assignees or IPC classes?
## Type-specific filters [#type-specific-filters]
On top of the [shared proof-point fields](/docs/proof-points):
* `applicationNumbers`, `grantNumbers`, `publicationNumbers`
* `states` — prosecution stage (`applied`, `published`, `granted`)
* `ipc` — International Patent Classification codes
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"query": "solid-state electrolyte",
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"states": ["granted"],
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 25,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "quarter",
"start": "2020-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Each patent can include `applicationNumber`, `grantNumber`, `publicationNumber`, `state`, `ipc`, plus the shared document fields (`title`, `publishedAt`, `topics`, `orgNodes`). Time series returns `labels` and `counts`.
# PDFs (/docs/proof-points/pdfs)
PDF proof points cover consulting reports and other indexed PDF documents. This replaces the deprecated consultancy-report indicator endpoints.
**Endpoints:**
* `POST /proof-points/pdfs/search` — [playground](/docs/api-reference/endpoints/search_pdfs_proof_points_pdfs_search_post)
* `POST /proof-points/pdfs/time-series` — [playground](/docs/api-reference/endpoints/pdfs_time_series_proof_points_pdfs_time_series_post)
* `POST /proof-points/pdfs/correlation-matrix` — [playground](/docs/api-reference/endpoints/pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post)
## Typical Questions [#typical-questions]
* Which consulting reports mention this topic?
* How does PDF document volume change over the selected window?
* Which organizations appear alongside the trend in long-form reports?
## Request Patterns [#request-patterns]
Uses the [shared proof-point fields](/docs/proof-points) only.
### Search [#search]
```json
{
"query": "battery recycling",
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 25,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "year",
"start": "2020-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Results use the shared enriched-document shape. Time series returns `labels` and `counts`.
# Projects (/docs/proof-points/projects)
Project proof points replace the deprecated **grants** indicator. Each record is an indexed project (for example CORDIS) with status, program, dates, and cost fields.
**Endpoints:**
* `POST /proof-points/projects/search` — [playground](/docs/api-reference/endpoints/search_projects_proof_points_projects_search_post)
* `POST /proof-points/projects/time-series` — [playground](/docs/api-reference/endpoints/projects_time_series_proof_points_projects_time_series_post)
* `POST /proof-points/projects/correlation-matrix` — [playground](/docs/api-reference/endpoints/projects_correlation_matrix_proof_points_projects_correlation_matrix_post)
## What changed from grants [#what-changed-from-grants]
The old grants API used nested `interval_overlap` on project start/end. On these endpoints, `start` and `end` are **published-date** bounds, the same as other proof points. Project interval fields (`startDate`, `endDate`) are still returned on each record so you can apply interval logic in your client.
## Typical Questions [#typical-questions]
* Which grant projects are tied to this topic?
* Is project volume increasing across the chosen window?
* How much capital (`totalCost` / `cordisEcContribution`) is associated with matching projects?
## Type-specific filters [#type-specific-filters]
On top of the [shared proof-point fields](/docs/proof-points):
* `statuses` — for example ongoing or closed
* `acronyms`
* `programs` — `fp7`, `horizon_2020`, `horizon_europe`
* `cordisGrantDois`
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"query": "battery recycling",
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"programs": ["horizon_europe"],
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 25,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "month",
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Each project can include `status`, `acronym`, `program`, `startDate`, `endDate`, `totalCost`, `cordisEcContribution`, and `cordisGrantDoi`. Time series returns `labels` and `counts` (and `amount` when capital is aggregated).
# Research articles (/docs/proof-points/research-articles)
Research-article proof points come from indexed scholarly documents. Date filters apply to **published date**.
**Endpoints:**
* `POST /proof-points/research-articles/search` — [playground](/docs/api-reference/endpoints/search_research_articles_proof_points_research_articles_search_post)
* `POST /proof-points/research-articles/time-series` — [playground](/docs/api-reference/endpoints/research_articles_time_series_proof_points_research_articles_time_series_post)
* `POST /proof-points/research-articles/correlation-matrix` — [playground](/docs/api-reference/endpoints/research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post)
## Typical Questions [#typical-questions]
* Is this trend still primarily academic, or already commercial?
* Which topics are gaining scientific attention fastest?
* What publications support a trend narrative?
## Type-specific filters [#type-specific-filters]
On top of the [shared proof-point fields](/docs/proof-points):
* `journals` — journal names
* `dois`
* `workTypes` — scholarly work types from the index
## Request Patterns [#request-patterns]
### Search [#search]
```json
{
"query": "precision fermentation",
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"start": "2022-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"take": 25,
"sortColumn": "published_at",
"sortDirection": "desc"
}
```
### Time series [#time-series]
```json
{
"topicIds": ["11111111-1111-1111-1111-111111111111"],
"resolution": "year",
"start": "2018-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
```
## Response Notes [#response-notes]
Each article can include `journal`, `journalAbbr`, `journalIssnL`, `doi`, `forwardCitationCount`, and `workType`, plus shared document fields. Time series returns `labels` and `counts`.
# Release 0.0.1 (/docs/release-notes/0.0.1)
Most `/indicators/*` endpoints are **deprecated**. They still respond so existing integrations keep working, but new work should use Proof Points, Facts, and Manifestations.
[Industry TSI](/docs/indicators/industry-tsi) is unchanged: `GET /indicators/industry-tsi/time-series`.
## What replaced indicators [#what-replaced-indicators]
| Use this when you need | New API |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| Indexed documents (patents, news, research, earnings calls, PDFs, grants/projects) | [Proof Points](/docs/proof-points) — `POST /proof-points/...` |
| Knowledge-graph organizations, investments, acquisitions | [Facts](/docs/facts) — `POST /facts/...` |
| Grouped events (partnerships, product launches, mixed types) | [Manifestations](/docs/core-concepts/manifestations) — `POST /manifestations/search` |
| Industry trend strength | [Industry TSI](/docs/indicators/industry-tsi) |
## Endpoint map [#endpoint-map]
| Deprecated | Replacement |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `GET /indicators/organizations/time-series` | `POST /facts/organizations/time-series` |
| `GET /indicators/organizations/proof-points` | `POST /facts/organizations/search` |
| `GET /indicators/investments/time-series` | `POST /facts/investments/time-series` |
| `GET /indicators/investments/proof-points` | `POST /facts/investments/search` |
| `GET /indicators/acquisitions/time-series` | `POST /facts/acquisitions/time-series` |
| `GET /indicators/acquisitions/proof-points` | `POST /facts/acquisitions/search` |
| `POST /indicators/news-articles/proofpoints` | `POST /proof-points/news-articles/search` |
| `POST /indicators/news-articles/time-series` | `POST /proof-points/news-articles/time-series` |
| `POST /indicators/patents/proofpoints` | `POST /proof-points/patents/search` |
| `POST /indicators/patents/time-series` | `POST /proof-points/patents/time-series` |
| `POST /indicators/research-articles/proofpoints` | `POST /proof-points/research-articles/search` |
| `POST /indicators/research-articles/time-series` | `POST /proof-points/research-articles/time-series` |
| `POST /indicators/earnings-calls/proofpoints` | `POST /proof-points/earnings-calls/search` |
| `POST /indicators/earnings-calls/time-series` | `POST /proof-points/earnings-calls/time-series` |
| `POST /indicators/grants/proofpoints` | `POST /proof-points/projects/search` |
| `POST /indicators/grants/time-series` | `POST /proof-points/projects/time-series` |
| `POST /indicators/consultancy-reports/proofpoints` | `POST /proof-points/pdfs/search` |
| `POST /indicators/consultancy-reports/time-series` | `POST /proof-points/pdfs/time-series` |
| `POST /indicators/partnerships/proofpoints` | `POST /manifestations/search` with `types: ["partnership"]` |
| `POST /indicators/partnerships/time-series` | `POST /manifestations/search`, or news-articles time series with `mentionsEvents: ["partnership"]` |
| `POST /indicators/product-launches/proofpoints` | `POST /manifestations/search` with `types: ["product-launch"]` |
| `POST /indicators/product-launches/time-series` | `POST /manifestations/search`, or news-articles time series with `mentionsEvents: ["product-launch"]` |
| `GET /indicators/industry-tsi/time-series` | Unchanged |
| `GET /indicators/*/summary-statistics` | No replacement |
Some old document routes used `/proofpoints` (no hyphen) and some fact routes used `/proof-points`. Both are deprecated; new document search lives under `/proof-points/{type}/search`.
## Breaking request changes [#breaking-request-changes]
* Nested `FilterClause` trees (`type: "and", clauses: [...]`) become a **flat JSON body**: `query`, `topicIds`, `organizationIds`, `start`, `end`.
* Organization, investment, and acquisition indicators were **GET + query params**. Replacements are **POST + JSON body**.
* Grants `interval_overlap` is not on `/proof-points/projects`. There, `start` / `end` are published-date bounds. Project `startDate` / `endDate` are still on each record.
* Proof points and facts page with `skip` / `take`. Manifestations page with `cursor` / `take`.
* Response shapes differ: enriched documents vs fact records vs manifestations with `references`.
Schemas for the new operations are in the [OpenAPI spec](https://connect-api.trendtracker.ai/openapi.json) and the [API reference](/docs/api-reference). Machine-readable docs: [/llms-full.txt](/llms-full.txt).
## Migrate with an LLM [#migrate-with-an-llm]
Paste the prompt below into Cursor, ChatGPT, or another coding agent **in the repository that calls Connect**. It tells the agent to load the live OpenAPI spec and apply the mapped endpoints instead of guessing field names.
```text
Migrate this codebase off deprecated Trendtracker Connect API `/indicators/*` callers onto Proof Points, Facts, and Manifestations.
Source of truth (fetch these; do not invent schemas):
- OpenAPI JSON: https://connect-api.trendtracker.ai/openapi.json
(If CONNECT_API is set, use `{CONNECT_API}/openapi.json` instead.)
- Release note with this mapping: Connect API docs "Release 0.0.1".
- Optional crawl: the docs host `/llms-full.txt`.
Rules:
1. Find every HTTP call, client method, type, fixture, and test that hits
`/indicators/...` including `proofpoints`, `proof-points`, `time-series`,
and `summary-statistics`.
2. Leave `GET /indicators/industry-tsi/time-series` unchanged.
3. Rewrite each other caller to the mapped replacement below. Use the
OpenAPI `requestBody` / `parameters` / response schema of the NEW
operation (POST JSON, camelCase aliases, required fields). Prefer the
spec over this table if they disagree on field names. Do not invent
query parameters the spec does not define.
4. Flatten old nested FilterClause trees (`type: "and"|"or"|"query"|
"interval_overlap"|...`) into the new flat filters (`query`, `topicIds`,
`organizationIds`, `start`, `end`, plus type-specific fields).
5. Switch GET + query-string fact indicators to POST + JSON body.
6. Update tests and fixtures. Report any caller you could not map,
including `summary-statistics` (no replacement).
Endpoint map:
GET /indicators/organizations/time-series → POST /facts/organizations/time-series
GET /indicators/organizations/proof-points → POST /facts/organizations/search
GET /indicators/investments/time-series → POST /facts/investments/time-series
GET /indicators/investments/proof-points → POST /facts/investments/search
GET /indicators/acquisitions/time-series → POST /facts/acquisitions/time-series
GET /indicators/acquisitions/proof-points → POST /facts/acquisitions/search
POST /indicators/news-articles/proofpoints → POST /proof-points/news-articles/search
POST /indicators/news-articles/time-series → POST /proof-points/news-articles/time-series
POST /indicators/patents/proofpoints → POST /proof-points/patents/search
POST /indicators/patents/time-series → POST /proof-points/patents/time-series
POST /indicators/research-articles/proofpoints → POST /proof-points/research-articles/search
POST /indicators/research-articles/time-series → POST /proof-points/research-articles/time-series
POST /indicators/earnings-calls/proofpoints → POST /proof-points/earnings-calls/search
POST /indicators/earnings-calls/time-series → POST /proof-points/earnings-calls/time-series
POST /indicators/grants/proofpoints → POST /proof-points/projects/search
POST /indicators/grants/time-series → POST /proof-points/projects/time-series
POST /indicators/consultancy-reports/proofpoints → POST /proof-points/pdfs/search
POST /indicators/consultancy-reports/time-series → POST /proof-points/pdfs/time-series
POST /indicators/partnerships/proofpoints → POST /manifestations/search (types: ["partnership"])
POST /indicators/partnerships/time-series → POST /manifestations/search, or POST /proof-points/news-articles/time-series with mentionsEvents: ["partnership"]
POST /indicators/product-launches/proofpoints → POST /manifestations/search (types: ["product-launch"])
POST /indicators/product-launches/time-series → POST /manifestations/search, or POST /proof-points/news-articles/time-series with mentionsEvents: ["product-launch"]
GET /indicators/industry-tsi/time-series → unchanged
```
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}
{
"openapi": "3.2.0",
"info": {
"title": "Trendtracker API",
"description": "An API to manage key trend indicators.",
"contact": {
"email": "mathias.colpaert@trensition.eu"
},
"version": "0.0.1"
},
"paths": {
"/indicators/acquisitions/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Time Series",
"description": "Returns a time series for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_time_series_indicators_acquisitions_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcquisitionTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/acquisitions/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Acquisition Proof Points",
"description": "Returns proof points for acquisitions, based on the input filters.\nThe start and end date filters relate to the acquisition date.",
"operationId": "get_acquisition_proof_points_indicators_acquisitions_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include acquisitions whose deal amount (USD) is less than or equal to this value."
},
{
"name": "acquisitionTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of acquisition. If not provided, all types are included.",
"title": "Acquisitiontypes"
},
"description": "Filters on the type of acquisition. If not provided, all types are included."
},
{
"name": "acquirerEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireremployeescounts"
},
"description": "Filters on the number of employees the acquirer organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "acquireeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Acquireeemployeescounts"
},
"description": "Filters on the number of employees the acquiree organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/AcquisitionProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "acquired_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_AcquisitionProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/consultancy-reports/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Consultancy Report Proofpoints",
"description": "Returns consultancy report (PDF) proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_consultancy_report_proofpoints_indicators_consultancy_reports_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/consultancy-reports/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Consultancy Report Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "consultancy_report_time_series_indicators_consultancy_reports_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Earnings Call Proofpoints",
"description": "Returns earnings call proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_call_proofpoints_indicators_earnings_calls_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/earnings-calls/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "earnings_calls_time_series_indicators_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Proofpoints",
"operationId": "grants_proofpoints_indicators_grants_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantIndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___1"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/grants/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Grants Time Series",
"operationId": "grants_time_series_indicators_grants_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntervalOverlapIndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/industries": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Industries",
"description": "Search for industries by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_industries_industries_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"default": 10,
"title": "Take"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/industry-tsi/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Industry Tsi Time Series",
"description": "Returns a time series for industry tsi, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_industry_tsi_time_series_indicators_industry_tsi_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "industryId",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The industry to fetch the tsi value for. Cross industry if not provided.",
"title": "Industryid"
},
"description": "The industry to fetch the tsi value for. Cross industry if not provided."
},
{
"name": "topicId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The topic to fetch the tsi values for.",
"title": "Topicid"
},
"description": "The topic to fetch the tsi values for."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndustryTsiTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Time Series",
"description": "Returns a time series for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_time_series_indicators_investments_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentTimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/investments/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Investment Proof Points",
"description": "Returns proof points for investments, based on the input filters.\nThe start and end date filters relate to the announced date.",
"operationId": "get_investment_proof_points_indicators_investments_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "topicIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicLink",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/event_models__indicators__investment__investment_topic_link__InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic.",
"default": "both"
},
"description": "Filters on the link between the organization involved in the investment and the topic."
},
{
"name": "minValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is strictly greater than this value.",
"title": "Minvalue"
},
"description": "If set, only include investments whose amount (USD) is strictly greater than this value."
},
{
"name": "maxValue",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "If set, only include investments whose amount (USD) is less than or equal to this value.",
"title": "Maxvalue"
},
"description": "If set, only include investments whose amount (USD) is less than or equal to this value."
},
{
"name": "investmentTypes",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
}
},
{
"type": "null"
}
],
"description": "Filters on the type of investment. If not provided, all types are included.",
"title": "Investmenttypes"
},
"description": "Filters on the type of investment. If not provided, all types are included."
},
{
"name": "investorEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investoremployeescounts"
},
"description": "Filters on the number of employees the investor organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "investeeEmployeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Investeeemployeescounts"
},
"description": "Filters on the number of employees the investee organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/InvestmentProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "announced_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_InvestmentProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/news-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Proofpoints",
"description": "Returns news article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_proofpoints_indicators_news_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/news-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "news_articles_time_series_indicators_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/organizations/time-series": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Time Series",
"description": "Returns a time series for organizations linked to a topic, aggregated by founded_on date. The input filters are applied.\nWhen no date filters are applied, the result also contains without_label,\n indicating what organizations don't have a founded_on date filled in.",
"operationId": "get_related_organization_time_series_indicators_organizations_time_series_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "resolution",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/NeoSupportedResolutions",
"description": "The resolution of the time series: year, quarter, or month.",
"default": "year"
},
"description": "The resolution of the time series: year, quarter, or month."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/organizations/proof-points": {
"get": {
"tags": [
"Indicators"
],
"summary": "Get Related Organization Proof Points",
"description": "Returns a list of organizations active in the topic, based on the input filters. If no date filters are given, organizations\nwithout a founded_date are also included",
"operationId": "get_related_organization_proof_points_indicators_organizations_proof_points_get",
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of results to skip.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The maximum number of results to return.",
"default": 10,
"title": "Take"
},
"description": "The maximum number of results to return."
},
{
"name": "sortDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortDirections",
"description": "The direction to sort the results.",
"default": "asc"
},
"description": "The direction to sort the results."
},
{
"name": "returnTotal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return the total number of results.",
"default": false,
"title": "Returntotal"
},
"description": "Whether to return the total number of results."
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or after this date.",
"title": "Start"
},
"description": "Only consider nodes/events on or after this date."
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"description": "Only consider nodes/events on or before this date.",
"title": "End"
},
"description": "Only consider nodes/events on or before this date."
},
{
"name": "topicIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"title": "Topicids"
}
},
{
"name": "organizationIds",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "When non-empty, restrict to events that involve these organizations.",
"title": "Organizationids"
},
"description": "When non-empty, restrict to events that involve these organizations."
},
{
"name": "loadChildren",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, include organizations active in child topics of the given topic(s).",
"default": false,
"title": "Loadchildren"
},
"description": "If True, include organizations active in child topics of the given topic(s)."
},
{
"name": "certainty",
"in": "query",
"required": false,
"schema": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description.",
"default": 0,
"title": "Certainty"
},
"description": "The certainty threshold for the organizations to be included in the results, use 0 to include all links.\nTypically certainty >= has the topic in the company name,\ncertainty >= 0.7 mentions the topic twice in the company description,\ncertainty >= 0.6 mentions the topic once in the company description and\ncertainty below that mentions the topic in the extended company description."
},
{
"name": "employeesCounts",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeesCount"
}
},
{
"type": "null"
}
],
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count.",
"title": "Employeescounts"
},
"description": "Filters on the number of employees the organization has, in different ranges. If not provided, all organizations are included.\nYou can use 'unknown' to include organizations with no employee count."
},
{
"name": "sortColumn",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrganizationProofPointSortColumns",
"description": "The column to sort the results by.",
"default": "founded_on"
},
"description": "The column to sort the results by."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_OrganizationProofPoint_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/indicators/partnerships/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Proofpoints",
"description": "Returns partnership-related proofpoints.",
"operationId": "partnerships_proofpoints_indicators_partnerships_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/partnerships/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Partnerships Time Series",
"description": "Aggregates partnership over time.",
"operationId": "partnerships_time_series_indicators_partnerships_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Search Patent Proofpoints",
"description": "Returns patent proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patent_proofpoints_indicators_patents_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/patents/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "patents_time_series_indicators_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Proofpoints",
"description": "Returns product launch proofpoints.",
"operationId": "product_launches_proofpoints_indicators_product_launches_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/product-launches/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Product Launches Time Series",
"description": "Aggregates product launches over time.",
"operationId": "product_launches_time_series_indicators_product_launches_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/proofpoints": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Proofpoints",
"description": "Returns research article proofpoints, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_proofpoints_indicators_research_articles_proofpoints_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DocumentBase_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/indicators/research-articles/time-series": {
"post": {
"tags": [
"Indicators"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.",
"operationId": "research_articles_time_series_indicators_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"deprecated": true,
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/manifestations/search": {
"post": {
"tags": [
"Manifestations"
],
"summary": "Search Manifestations",
"description": "Returns manifestations grouped from proof points, product launches, and facts, based on the input filters.",
"operationId": "search_manifestations_manifestations_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManifestationPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Proof Points Correlation Matrix",
"description": "Returns a correlation matrix across all proof point document types.",
"operationId": "proof_points_correlation_matrix_proof_points_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Correlation Matrix",
"operationId": "news_articles_correlation_matrix_proof_points_news_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Correlation Matrix",
"operationId": "research_articles_correlation_matrix_proof_points_research_articles_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Correlation Matrix",
"operationId": "patents_correlation_matrix_proof_points_patents_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Correlation Matrix",
"operationId": "projects_correlation_matrix_proof_points_projects_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Correlation Matrix",
"operationId": "pdfs_correlation_matrix_proof_points_pdfs_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/correlation-matrix": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Correlation Matrix",
"operationId": "earnings_calls_correlation_matrix_proof_points_earnings_calls_correlation_matrix_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofPointCorrelationMatrixParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CorrelationMatrix"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Earnings Calls",
"description": "Returns earnings call proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_earnings_calls_proof_points_earnings_calls_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EarningsCall_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/earnings-calls/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Earnings Calls Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "earnings_calls_time_series_proof_points_earnings_calls_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search News Articles",
"description": "Returns news article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_news_articles_proof_points_news_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_NewsArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/news-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "News Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "news_articles_time_series_proof_points_news_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Patents",
"description": "Returns patent proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_patents_proof_points_patents_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Patent_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/patents/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Patents Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "patents_time_series_proof_points_patents_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatentTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Pdfs",
"description": "Returns PDF proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_pdfs_proof_points_pdfs_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Pdf_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/pdfs/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Pdfs Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "pdfs_time_series_proof_points_pdfs_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Projects",
"description": "Returns project proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_projects_proof_points_projects_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_models__core_models__page__Page_Project___2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/projects/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Projects Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "projects_time_series_proof_points_projects_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/search": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Search Research Articles",
"description": "Returns research article proof points, based on the input filters.\nThe start and end date filters relate to the published date.",
"operationId": "search_research_articles_proof_points_research_articles_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ResearchArticle_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/proof-points/research-articles/time-series": {
"post": {
"tags": [
"Proof Points"
],
"summary": "Research Articles Time Series",
"description": "Aggregates document counts per time bucket (month or year). Supports the same nested filters as search.\nThe start and end date filters relate to the published date.",
"operationId": "research_articles_time_series_proof_points_research_articles_time_series_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchArticleTimeSeriesParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": [
"license"
]
}
]
}
},
"/topics/{topic_id}/related": {
"get": {
"tags": [
"Topics"
],
"summary": "Get Related Topics",
"description": "Returns related topics for a given topic id, based on how many organizations are active in both the topic and the related topic.\nThe result is normalized using jaccard similarity score. For very large topics (more than 5000 orgs active in it), Jaccard is skipped\nand the similarity score is always 1.",
"operationId": "get_related_topics_topics__topic_id__related_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "topic_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Topic Id"
}
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size.",
"default": 10,
"title": "Take"
},
"description": "The number of related topics to return, all topics are caculated anyways, this is just to limit response size."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedTopic"
},
"title": "Response Get Related Topics Topics Topic Id Related Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topics": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topics",
"description": "Search for topics by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topics_topics_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 50
},
{
"type": "null"
}
],
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "The number of results to skip, when paging.",
"default": 0,
"title": "Skip"
},
"description": "The number of results to skip, when paging."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
},
{
"name": "topicSetIds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Topicsetids"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/topic-sets": {
"get": {
"tags": [
"Topics"
],
"summary": "Search Topic Sets",
"description": "Search for topic set by keyword and return the most relevant matches, ordered by name.",
"operationId": "search_topic_sets_topic_sets_get",
"security": [
{
"APIKeyHeader": [
"superAdmin"
]
}
],
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The query to search for.",
"title": "Query"
},
"description": "The query to search for."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "The number of results to return, ordered by descending relevance.",
"default": 10,
"title": "Take"
},
"description": "The number of results to return, ordered by descending relevance."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_IdNameModel_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcquisitionFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__acquisition_topic_link__AcquisitionTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"acquisitionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AcquisitionTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitiontypes"
},
"acquirerEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireremployeescounts"
},
"acquireeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquireeemployeescounts"
}
},
"type": "object",
"title": "AcquisitionFilter"
},
"AcquisitionProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the acquisition."
},
"acquisitionType": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionTypes"
},
{
"type": "null"
}
],
"description": "The type of acquisition."
},
"acquiredOn": {
"type": "string",
"format": "date",
"title": "Acquiredon",
"description": "The date the acquisition was completed."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The amount of the acquisition in USD."
},
"acquirer": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that acquired the other organization."
},
"acquiree": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was acquired."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the trend."
}
},
"type": "object",
"required": [
"id",
"acquisitionType",
"acquiredOn",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPoint"
},
"AcquisitionProofPointSortColumns": {
"type": "string",
"enum": [
"acquired_on",
"amount",
"acquirer",
"acquiree",
"certainty"
],
"title": "AcquisitionProofPointSortColumns"
},
"AcquisitionTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The price of the acquisitions in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "AcquisitionTimeSeries",
"description": "A time series for acquisitions, based on the input filters."
},
"AcquisitionTypes": {
"type": "string",
"enum": [
"acquihire",
"acquisition",
"leveraged_buyout",
"management_buyout",
"merge"
],
"title": "AcquisitionTypes"
},
"AndGroup": {
"properties": {
"type": {
"type": "string",
"const": "and",
"title": "Type",
"default": "and"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; all must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "AndGroup",
"description": "All nested clauses must match (AND)."
},
"CandidateFilter": {
"properties": {
"type": {
"type": "string",
"const": "candidate",
"title": "Type",
"default": "candidate"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Must be one of ``NodeTypes.indexed_candidate_types()`` (e.g. ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Knowledge-graph candidate node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "CandidateFilter",
"description": "Filter by ER candidate ids indexed on ``candidates__`` (detected-entity candidates)."
},
"CorrelationMatrix": {
"properties": {
"cells": {
"items": {
"$ref": "#/components/schemas/CorrelationMatrixCell"
},
"type": "array",
"title": "Cells"
}
},
"type": "object",
"required": [
"cells"
],
"title": "CorrelationMatrix"
},
"CorrelationMatrixCell": {
"properties": {
"row": {
"type": "integer",
"title": "Row"
},
"col": {
"type": "integer",
"title": "Col"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"row",
"col",
"count"
],
"title": "CorrelationMatrixCell"
},
"CrossFieldQueryStrategy": {
"type": "string",
"enum": [
"best_fields",
"most_fields",
"cross_fields",
"phrase",
"phrase_prefix"
],
"title": "CrossFieldQueryStrategy",
"description": "Maps to elasticsearch multi_match query type."
},
"DateFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "date",
"title": "Type",
"default": "date"
},
"field": {
"type": "string",
"const": "published_at",
"title": "Field",
"description": "Date field to filter on.",
"default": "published_at"
}
},
"type": "object",
"title": "DateFilter",
"description": "Date range filter on a date field (e.g. published_at)."
},
"DetectedNodes": {
"properties": {
"acquisition": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisition"
},
"city": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "City"
},
"country": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"gpe": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpe"
},
"investment": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investment"
},
"merger": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Merger"
},
"org": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Org"
},
"candidatesOrg": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Candidatesorg"
},
"partnership": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnership"
},
"settlement": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlement"
},
"subCountry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountry"
},
"worldRegion": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregion"
}
},
"type": "object",
"title": "DetectedNodes"
},
"DetectedParentGpes": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"title": "DetectedParentGpes"
},
"DetectedTopics": {
"properties": {
"document": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Document"
},
"title": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Body"
}
},
"type": "object",
"title": "DetectedTopics"
},
"DocumentBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
}
},
"type": "object",
"title": "DocumentBase"
},
"DocumentType": {
"type": "string",
"enum": [
"article",
"earnings-call",
"pdf",
"patent",
"project",
"research-article"
],
"title": "DocumentType"
},
"EarningsCall": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "EarningsCall",
"description": "An earnings call transcript or related document."
},
"EarningsCallSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "EarningsCallSearchParams"
},
"EarningsCallTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "EarningsCallTimeSeriesParams"
},
"EmployeesCount": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-100",
"101-250",
"251-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+",
"unknown"
],
"title": "EmployeesCount"
},
"FactTypes": {
"type": "string",
"enum": [
"organization",
"investment",
"acquisition"
],
"title": "FactTypes"
},
"GrantIndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "GrantIndexSearchParams",
"description": "Search params for grant/project indicators where DateFilter is forbidden."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"IdNameModel": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
}
},
"type": "object",
"required": [
"id"
],
"title": "IdNameModel"
},
"IndexCalendarIntervals": {
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"title": "IndexCalendarIntervals"
},
"IndexScoreConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScoreTier"
},
"type": "array",
"title": "Tiers"
},
"publishedAtDecay": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedAtDecayConfig"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"tiers"
],
"title": "IndexScoreConfig",
"description": "Top-level scoring configuration: ordered tiers only."
},
"IndexSearchParams": {
"properties": {
"fields": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/QueryableFields"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fields",
"description": "Fields to fetch and return. When absent or empty, all fields are returned.",
"examples": [
[
"id",
"publishedAt",
"title"
]
]
},
"nodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/NodeTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Nodes",
"description": "Nodes to fetch and return.",
"examples": [
[
"org"
]
]
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics",
"description": "The fields to fetch topics for.",
"examples": [
[
"title"
]
]
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__queryable_content_field__QueryableContentField"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes",
"description": "The fields to fetch parent GPE topic ids for.",
"examples": [
[
"title"
]
]
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"title": "Take",
"description": "Number of records to return. Use 0 for count-only queries, or -1 to fetch all matching records.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexSearchSortColumns",
"description": "Column to sort results by.",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Candidate, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute per-document score and weighted analytics.",
"examples": [
null
]
}
},
"type": "object",
"title": "IndexSearchParams",
"description": "Search and paging parameters for querying documents in an elastic index."
},
"IndexSearchSortColumns": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexSearchSortColumns",
"description": "Sortable columns for index document search. Values match Elasticsearch field names."
},
"IndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
}
},
"type": "object",
"title": "IndexTimeSeriesParams",
"description": "Parameters for time-series aggregation over an elastic index."
},
"IndexedDocumentSort": {
"type": "string",
"enum": [
"published_at",
"score"
],
"title": "IndexedDocumentSort"
},
"IndustryTsiTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"normalized": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Normalized",
"description": "The normalized strength values over time."
}
},
"type": "object",
"required": [
"labels",
"normalized"
],
"title": "IndustryTsiTimeSeries"
},
"IntervalOverlapFilter": {
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"type": {
"type": "string",
"const": "interval_overlap",
"title": "Type",
"default": "interval_overlap"
}
},
"type": "object",
"title": "IntervalOverlapFilter",
"description": "Date interval overlap filter on project interval fields."
},
"IntervalOverlapIndexTimeSeriesParams": {
"properties": {
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"description": "Calendar interval for the time series.",
"default": "year"
},
"query": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
{
"type": "null"
}
],
"title": "Query",
"description": "Nested filter clauses (AND/OR with Query, Topics, Node, Date, Terms).",
"examples": [
null
]
},
"score": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexScoreConfig"
},
{
"type": "null"
}
],
"description": "Optional scoring configuration used to compute weighted counts.",
"examples": [
null
]
},
"includeVariance": {
"type": "boolean",
"title": "Includevariance",
"description": "When True and score is set, adds a per-bucket variance of scores (for confidence intervals).",
"default": false
},
"start": {
"type": "string",
"format": "date",
"title": "Start",
"description": "Inclusive start date for calendar bucket generation."
},
"end": {
"type": "string",
"format": "date",
"title": "End",
"description": "Inclusive end date for calendar bucket generation."
}
},
"type": "object",
"required": [
"start",
"end"
],
"title": "IntervalOverlapIndexTimeSeriesParams",
"description": "Time-series params for calendar buckets with document-interval overlap weighting."
},
"InvestmentFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"topicLink": {
"$ref": "#/components/schemas/event_models__facts__investment_topic_link__InvestmentTopicLink",
"default": "both"
},
"minValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minvalue"
},
"maxValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maxvalue"
},
"investmentTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InvestmentTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmenttypes"
},
"investorEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investoremployeescounts"
},
"investeeEmployeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investeeemployeescounts"
}
},
"type": "object",
"title": "InvestmentFilter"
},
"InvestmentProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the investment."
},
"investmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentTypes"
},
{
"type": "null"
}
],
"description": "The type of investment."
},
"announcedOn": {
"type": "string",
"format": "date",
"title": "Announcedon",
"description": "The date the investment was announced."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The total amount of the investment in USD."
},
"investors": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Investors",
"description": "The organization that invested in the other organization."
},
"investee": {
"$ref": "#/components/schemas/IdNameModel",
"description": "The organization that was invested in."
},
"certainty": {
"type": "number",
"title": "Certainty",
"description": "The certainty that the organization is related to the topic."
}
},
"type": "object",
"required": [
"id",
"investmentType",
"announcedOn",
"amount",
"investors",
"investee",
"certainty"
],
"title": "InvestmentProofPoint"
},
"InvestmentProofPointSortColumns": {
"type": "string",
"enum": [
"announced_on",
"amount",
"investee",
"certainty"
],
"title": "InvestmentProofPointSortColumns"
},
"InvestmentTimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
},
"amounts": {
"items": {
"type": "number"
},
"type": "array",
"title": "Amounts",
"description": "The total amount of the investments in USD for each of the time buckets."
}
},
"type": "object",
"required": [
"labels",
"counts",
"amounts"
],
"title": "InvestmentTimeSeries",
"description": "A time series for investments, based on the input filters."
},
"InvestmentTypes": {
"type": "string",
"enum": [
"angel",
"debt_financing",
"convertible_note",
"corporate_round",
"equity_crowdfunding",
"grant",
"initial_coin_offering",
"non_equity_assistance",
"post_ipo_debt",
"post_ipo_equity",
"post_ipo_secondary",
"pre_seed",
"private_equity",
"product_crowdfunding",
"secondary_market",
"seed",
"series_a",
"series_b",
"series_c",
"series_d",
"series_e",
"series_f",
"series_g",
"series_h",
"series_i",
"series_j",
"series_unknown",
"undisclosed"
],
"title": "InvestmentTypes"
},
"LanguageCodes": {
"type": "string",
"enum": [
"ar",
"zh",
"nl",
"en",
"fr",
"de",
"xx",
"ja",
"ko",
"pt",
"es",
"th",
"vi"
],
"title": "LanguageCodes"
},
"Manifestation": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"references": {
"items": {
"$ref": "#/components/schemas/ManifestationReference"
},
"type": "array",
"title": "References"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End"
},
"uniqueSourceCount": {
"type": "integer",
"title": "Uniquesourcecount",
"default": 0
},
"companies": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Companies"
},
"products": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Products"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount"
}
},
"type": "object",
"required": [
"type",
"references"
],
"title": "Manifestation"
},
"ManifestationMetadata": {
"properties": {
"lcTitle": {
"type": "string",
"title": "Lctitle"
},
"uniqueSourceIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Uniquesourceids"
},
"productNamesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productnameslc"
},
"productLaunchingCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Productlaunchingcompanieslc"
},
"partnershipPartnersLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershippartnerslc"
},
"partnershipCompaniesLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Partnershipcompanieslc"
},
"investmentInvesteeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Investmentinvesteelc"
},
"investmentInvestorsLc": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Investmentinvestorslc"
},
"acquisitionAcquirerLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquirerlc"
},
"acquisitionAcquireeLc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acquisitionacquireelc"
}
},
"type": "object",
"required": [
"lcTitle"
],
"title": "ManifestationMetadata"
},
"ManifestationPage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Manifestation"
},
"type": "array",
"title": "Data"
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
"type": "object",
"required": [
"data"
],
"title": "ManifestationPage"
},
"ManifestationReference": {
"properties": {
"type": {
"$ref": "#/components/schemas/ManifestationReferenceTypes"
},
"id": {
"type": "string",
"title": "Id"
},
"proofPointType": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentType"
},
{
"type": "null"
}
]
},
"factType": {
"anyOf": [
{
"$ref": "#/components/schemas/FactTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "ManifestationReference"
},
"ManifestationReferenceTypes": {
"type": "string",
"enum": [
"proof_point",
"fact"
],
"title": "ManifestationReferenceTypes"
},
"ManifestationSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ManifestationTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Types"
},
"newsEventFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsEventFilter"
},
{
"type": "null"
}
]
},
"productLaunchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductLaunchFilter"
},
{
"type": "null"
}
]
},
"partnershipFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/PartnershipFilter"
},
{
"type": "null"
}
]
},
"organizationFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizationFilter"
},
{
"type": "null"
}
]
},
"investmentFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/InvestmentFilter"
},
{
"type": "null"
}
]
},
"acquisitionFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/AcquisitionFilter"
},
{
"type": "null"
}
]
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
}
},
"type": "object",
"title": "ManifestationSearchParams"
},
"ManifestationTypes": {
"type": "string",
"enum": [
"news-event",
"patent",
"research-article",
"consulting-report",
"earnings-call",
"product-launch",
"organization",
"investment",
"acquisition",
"partnership"
],
"title": "ManifestationTypes"
},
"MentionsEvent": {
"type": "string",
"enum": [
"product-launch",
"partnership",
"investment",
"acquisition"
],
"title": "MentionsEvent"
},
"NeoSupportedResolutions": {
"type": "string",
"enum": [
"month",
"quarter",
"year"
],
"title": "NeoSupportedResolutions"
},
"NewsArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountries": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountries"
}
},
"type": "object",
"title": "NewsArticle",
"description": "A regular article from the web."
},
"NewsArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"sourceCountries",
"sourceIsPremium",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "NewsArticleSearchParams"
},
"NewsArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"sourceIsPremium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sourceispremium"
},
"sourceCountryIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourcecountryids"
},
"mentionsEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MentionsEvent"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentionsevents"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "NewsArticleTimeSeriesParams"
},
"NewsEventFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "NewsEventFilter"
},
"NodeFilter": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes",
"description": "Node type (e.g. GPE, ORG)."
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Node ids to filter by."
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeFilter",
"description": "Filter by node type and node ids (terms on nodes__)."
},
"NodeScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "node",
"title": "Type",
"default": "node"
},
"nodeType": {
"$ref": "#/components/schemas/NodeTypes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
}
},
"type": "object",
"required": [
"nodeType",
"ids"
],
"title": "NodeScoreMultiplier"
},
"NodeTypes": {
"type": "string",
"enum": [
"acquisition",
"city",
"country",
"gpe",
"investment",
"merger",
"org",
"partnership",
"person",
"product",
"settlement",
"sub_country",
"topic",
"world_region"
],
"title": "NodeTypes"
},
"NotGroup": {
"properties": {
"type": {
"type": "string",
"const": "not",
"title": "Type",
"default": "not"
},
"clause": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"title": "Clause",
"description": "The clause that must not match.",
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
}
},
"type": "object",
"required": [
"clause"
],
"title": "NotGroup",
"description": "Negate a single nested clause (NOT)."
},
"OrGroup": {
"properties": {
"type": {
"type": "string",
"const": "or",
"title": "Type",
"default": "or"
},
"clauses": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AndGroup"
},
{
"$ref": "#/components/schemas/OrGroup"
},
{
"$ref": "#/components/schemas/NotGroup"
},
{
"$ref": "#/components/schemas/QueryFilter"
},
{
"$ref": "#/components/schemas/TopicsFilter"
},
{
"$ref": "#/components/schemas/ParentGpesFilter"
},
{
"$ref": "#/components/schemas/NodeFilter"
},
{
"$ref": "#/components/schemas/CandidateFilter"
},
{
"$ref": "#/components/schemas/DateFilter"
},
{
"$ref": "#/components/schemas/IntervalOverlapFilter"
},
{
"$ref": "#/components/schemas/TermsFilter"
},
{
"$ref": "#/components/schemas/SourceIsPremiumFilter"
},
{
"$ref": "#/components/schemas/SourceCountriesFilter"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"and": "#/components/schemas/AndGroup",
"candidate": "#/components/schemas/CandidateFilter",
"date": "#/components/schemas/DateFilter",
"interval_overlap": "#/components/schemas/IntervalOverlapFilter",
"node": "#/components/schemas/NodeFilter",
"not": "#/components/schemas/NotGroup",
"or": "#/components/schemas/OrGroup",
"parent_gpes": "#/components/schemas/ParentGpesFilter",
"query": "#/components/schemas/QueryFilter",
"source_countries": "#/components/schemas/SourceCountriesFilter",
"source_is_premium": "#/components/schemas/SourceIsPremiumFilter",
"terms": "#/components/schemas/TermsFilter",
"topics": "#/components/schemas/TopicsFilter"
}
}
},
"type": "array",
"title": "Clauses",
"description": "Nested filter clauses; at least one must match."
}
},
"type": "object",
"required": [
"clauses"
],
"title": "OrGroup",
"description": "At least one nested clause must match (OR)."
},
"OrganizationFilter": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this date."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this date."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty threshold for the organizations to be included in the results.",
"default": 0
},
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 50
},
{
"type": "null"
}
],
"title": "Query",
"description": "Optional free-text search over organization labels."
},
"employeesCounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EmployeesCount"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Employeescounts"
}
},
"type": "object",
"title": "OrganizationFilter"
},
"OrganizationProofPoint": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the node in the knowledge graph."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name (label) of the node in the knowledge graph."
},
"foundedOn": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Foundedon",
"description": "The date the organization was founded, or None if not available."
},
"certainty": {
"type": "number",
"maximum": 1,
"minimum": 0,
"title": "Certainty",
"description": "The certainty of the organization being active in the topic."
},
"employeesCount": {
"anyOf": [
{
"$ref": "#/components/schemas/EmployeesCount"
},
{
"type": "null"
}
],
"description": "The number of employees the organization has, or None if not available."
}
},
"type": "object",
"required": [
"id",
"certainty"
],
"title": "OrganizationProofPoint",
"description": "An organization stored in the knowledge graph."
},
"OrganizationProofPointSortColumns": {
"type": "string",
"enum": [
"name",
"founded_on",
"certainty"
],
"title": "OrganizationProofPointSortColumns"
},
"Page_AcquisitionProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AcquisitionProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[AcquisitionProofPoint]"
},
"Page_DocumentBase_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DocumentBase"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[DocumentBase]"
},
"Page_EarningsCall_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EarningsCall"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[EarningsCall]"
},
"Page_IdNameModel_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[IdNameModel]"
},
"Page_InvestmentProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvestmentProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[InvestmentProofPoint]"
},
"Page_NewsArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/NewsArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[NewsArticle]"
},
"Page_OrganizationProofPoint_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationProofPoint"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[OrganizationProofPoint]"
},
"Page_Patent_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Patent"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Patent]"
},
"Page_Pdf_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Pdf"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Pdf]"
},
"Page_ResearchArticle_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ResearchArticle"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[ResearchArticle]"
},
"ParentGpesFilter": {
"properties": {
"type": {
"type": "string",
"const": "parent_gpes",
"title": "Type",
"default": "parent_gpes"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids to filter by (detected entity and parent ids are both indexed)."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to parent_gpes__title, parent_gpes__summary, or parent_gpes. Use Document for parent_gpes."
}
},
"type": "object",
"required": [
"ids"
],
"title": "ParentGpesFilter",
"description": "Filter by GPE topic ids (terms on parent_gpes or parent_gpes__*)."
},
"PartnershipFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results."
}
},
"type": "object",
"title": "PartnershipFilter"
},
"Patent": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"applicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Applicationnumber",
"description": "USPTO prosecution case number (series + serial), normalized. Stable for the application lifecycle."
},
"grantNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grantnumber",
"description": "Full WIPO grant-document citation: country + issued patent number + kind code (e.g. ``US11858000B2``).\n\nStable once granted; used as the canonical granted-patent identifier and Espacenet ``url`` target."
},
"publicationNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Publicationnumber",
"description": "Pre-grant application publication (PGPub) citation (e.g. ``US20210220874A1``).\n\nPresent when the application was published before grant; absent for older grants or unpublished filings."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"description": "Prosecution lifecycle stage: ``applied``, ``published``, or ``granted``."
},
"ipc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ipc",
"description": "International Patent Code."
}
},
"type": "object",
"title": "Patent"
},
"PatentSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"applicationNumber",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"grantNumber",
"id",
"image",
"investmentNodes",
"ipc",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publicationNumber",
"publishedAt",
"score",
"settlementNodes",
"source",
"state",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PatentSearchParams"
},
"PatentTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"applicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applicationnumbers"
},
"grantNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grantnumbers"
},
"publicationNumbers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Publicationnumbers"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "States"
},
"ipc": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ipc"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PatentTimeSeriesParams"
},
"Pdf": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Pdf"
},
"PdfSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"domain",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "PdfSearchParams"
},
"PdfTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "PdfTimeSeriesParams"
},
"ProductLaunchFilter": {
"properties": {
"minUniqueSourceCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minuniquesourcecount",
"description": "The minimum number of unique sources that a manifestation must have to be included in the results. \nIgnored for patents and research articles."
}
},
"type": "object",
"title": "ProductLaunchFilter"
},
"ProjectSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"acronym",
"body",
"cityNodes",
"cordisEcContribution",
"cordisGrantDoi",
"countryNodes",
"domain",
"endDate",
"gpeNodes",
"id",
"image",
"investmentNodes",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"program",
"publishedAt",
"score",
"settlementNodes",
"source",
"startDate",
"status",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"totalCost",
"url",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ProjectSearchParams"
},
"ProjectTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"statuses": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Statuses"
},
"acronyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acronyms"
},
"programs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProjectTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Programs"
},
"cordisGrantDois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Cordisgrantdois"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ProjectTimeSeriesParams"
},
"ProjectTypes": {
"type": "string",
"enum": [
"fp7",
"horizon_2020",
"horizon_europe"
],
"title": "ProjectTypes"
},
"ProofPointCorrelationAxis": {
"properties": {
"kind": {
"$ref": "#/components/schemas/ProofPointCorrelationAxisKind"
},
"groups": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"minItems": 1,
"title": "Groups",
"description": "OR-groups of entity ids; each group is exactly one bucket."
}
},
"type": "object",
"required": [
"kind",
"groups"
],
"title": "ProofPointCorrelationAxis"
},
"ProofPointCorrelationAxisKind": {
"type": "string",
"enum": [
"topic",
"organization"
],
"title": "ProofPointCorrelationAxisKind"
},
"ProofPointCorrelationMatrixParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"rows": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
},
"cols": {
"$ref": "#/components/schemas/ProofPointCorrelationAxis"
}
},
"type": "object",
"required": [
"rows",
"cols"
],
"title": "ProofPointCorrelationMatrixParams"
},
"PublishedAtDecayConfig": {
"properties": {
"origin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin"
},
"scale": {
"type": "integer",
"title": "Scale",
"default": 30
},
"offset": {
"type": "string",
"title": "Offset",
"default": "0d"
},
"decay": {
"type": "number",
"title": "Decay",
"default": 0.5
}
},
"type": "object",
"title": "PublishedAtDecayConfig",
"description": "Top-level decay modifier on published_at (applied after tier score)."
},
"QueryFilter": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
},
"query": {
"type": "string",
"title": "Query",
"description": "Search text."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Which content fields to search. Use Document for all of title, summary, body."
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "True = phrase match, False = loose match.",
"default": false
}
},
"type": "object",
"required": [
"query"
],
"title": "QueryFilter",
"description": "Full-text search over document content fields."
},
"QueryScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "query",
"title": "Type",
"default": "query"
}
},
"type": "object",
"title": "QueryScoreMultiplier"
},
"QueryableFields": {
"type": "string",
"enum": [
"body",
"domain",
"id",
"image",
"language",
"publishedAt",
"score",
"source",
"summary",
"title",
"url",
"relex",
"sourceIsPremium",
"sourceCountries",
"ipc",
"status",
"acronym",
"program",
"cordisEcContribution",
"cordisGrantDoi",
"endDate",
"startDate",
"totalCost",
"journal",
"journalAbbr",
"journalIssnL",
"doi",
"forwardCitationCount",
"workType"
],
"title": "QueryableFields",
"description": "API oriented list of fields that can be queried."
},
"RelatedTopic": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the related topic."
},
"label": {
"type": "string",
"title": "Label",
"description": "The label of the related topic."
},
"sharedOrgs": {
"type": "integer",
"title": "Sharedorgs",
"description": "The number of organizations that are active in both the topic and the related topic."
},
"similarity": {
"type": "number",
"title": "Similarity",
"description": "The Jaccard similarity score between the topic and the related topic. \nAlways returns 1 for topics with more than 5000 orgs active in it."
}
},
"type": "object",
"required": [
"id",
"label",
"sharedOrgs",
"similarity"
],
"title": "RelatedTopic",
"description": "A related topic to a given topic, based on how many organizations are active in both the topic and the related topic."
},
"ResearchArticle": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"journal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journal",
"description": "Journal's full name."
},
"journalAbbr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalabbr",
"description": "Journal's abbreviated name."
},
"journalIssnL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Journalissnl",
"description": "Journal's Linking International Standard Serial Number (ISSN-L)."
},
"doi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Doi"
},
"forwardCitationCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Forwardcitationcount"
},
"workType": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkTypes"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "ResearchArticle"
},
"ResearchArticleSearchParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"fields": {
"items": {
"enum": [
"acquisitionNodes",
"body",
"cityNodes",
"countryNodes",
"doi",
"domain",
"forwardCitationCount",
"gpeNodes",
"id",
"image",
"investmentNodes",
"journal",
"journalAbbr",
"journalIssnL",
"language",
"mergerNodes",
"orgNodes",
"parentGpes",
"parentGpesSummary",
"parentGpesTitle",
"partnershipNodes",
"publishedAt",
"score",
"settlementNodes",
"source",
"subCountryNodes",
"summary",
"title",
"topics",
"topicsBody",
"topicsSummary",
"topicsTitle",
"url",
"workType",
"worldRegionNodes"
]
},
"type": "array",
"minItems": 1,
"title": "Fields",
"default": [
"publishedAt",
"title"
]
}
},
"type": "object",
"title": "ResearchArticleSearchParams"
},
"ResearchArticleTimeSeriesParams": {
"properties": {
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ids",
"description": "Filter by document global ids."
},
"topicIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicids"
},
"organizationIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Organizationids"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
},
"queryFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Queryfields",
"default": [
"title"
]
},
"queryStrategy": {
"anyOf": [
{
"$ref": "#/components/schemas/CrossFieldQueryStrategy"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LanguageCodes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Languages"
},
"sourceIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sourceids"
},
"topicFields": {
"items": {
"enum": [
"body",
"summary",
"title"
]
},
"type": "array",
"minItems": 1,
"title": "Topicfields",
"default": [
"title",
"summary",
"body"
]
},
"gpeIds": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpeids"
},
"start": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start",
"description": "Only consider nodes/events on or after this datetime."
},
"end": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End",
"description": "Only consider nodes/events on or before this datetime."
},
"includeStart": {
"type": "boolean",
"title": "Includestart",
"description": "Whether the start bound is inclusive (>=) or exclusive (>).",
"default": true
},
"includeEnd": {
"type": "boolean",
"title": "Includeend",
"description": "Whether the end bound is inclusive (<=) or exclusive (<).",
"default": true
},
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Enable debug mode.",
"default": false
},
"journals": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Journals"
},
"dois": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Dois"
},
"workTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkTypes"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worktypes"
},
"skip": {
"type": "integer",
"minimum": 0,
"title": "Skip",
"description": "The number of records to skip before fetching a page.",
"default": 0
},
"take": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Take",
"description": "Number of records to return.",
"default": 100
},
"sortColumn": {
"$ref": "#/components/schemas/IndexedDocumentSort",
"default": "published_at"
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirections",
"default": "desc"
},
"returnTotal": {
"type": "boolean",
"title": "Returntotal",
"default": false
},
"resolution": {
"$ref": "#/components/schemas/IndexCalendarIntervals",
"default": "year"
}
},
"type": "object",
"title": "ResearchArticleTimeSeriesParams"
},
"ScoreTier": {
"properties": {
"multipliers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/QueryScoreMultiplier"
},
{
"$ref": "#/components/schemas/TopicScoreMultiplier"
},
{
"$ref": "#/components/schemas/NodeScoreMultiplier"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"node": "#/components/schemas/NodeScoreMultiplier",
"query": "#/components/schemas/QueryScoreMultiplier",
"topic": "#/components/schemas/TopicScoreMultiplier"
}
}
},
"type": "array",
"title": "Multipliers"
}
},
"type": "object",
"required": [
"multipliers"
],
"title": "ScoreTier",
"description": "Tier definition with normalized multipliers."
},
"SortDirections": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirections"
},
"SourceCountriesFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_countries",
"title": "Type",
"default": "source_countries"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "GPE topic ids from the source's countries list."
}
},
"type": "object",
"required": [
"ids"
],
"title": "SourceCountriesFilter",
"description": "Filter by source country GPE topic ids (Article indexes only)."
},
"SourceIsPremiumFilter": {
"properties": {
"type": {
"type": "string",
"const": "source_is_premium",
"title": "Type",
"default": "source_is_premium"
},
"value": {
"type": "boolean",
"title": "Value",
"description": "True to match premium sources, False to match non-premium."
}
},
"type": "object",
"required": [
"value"
],
"title": "SourceIsPremiumFilter",
"description": "Filter by whether the document's source is premium (Article indexes only)."
},
"TermsFilter": {
"properties": {
"type": {
"type": "string",
"const": "terms",
"title": "Type",
"default": "terms"
},
"value": {
"type": "string",
"title": "Value",
"description": "Exact value to match."
},
"field": {
"$ref": "#/components/schemas/TermsFilterField",
"description": "Field to match: source_id, global_id, domain, language or relex."
}
},
"type": "object",
"required": [
"value",
"field"
],
"title": "TermsFilter",
"description": "Exact match on a keyword field."
},
"TermsFilterField": {
"type": "string",
"enum": [
"source_id",
"global_id",
"domain",
"language",
"relex"
],
"title": "TermsFilterField",
"description": "Keyword fields for exact-term filters."
},
"TimeSeries": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"title": "Labels",
"description": "The labels for the time series, sorted by time."
},
"counts": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Counts",
"description": "The number of proofpoints for each of the time buckets."
},
"amount": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "Total monetary amount for each time bucket."
},
"weightedCounts": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Weightedcounts",
"description": "Optional weighted score sums for each time bucket when score-aware aggregation is enabled."
},
"variances": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Variances",
"description": "Optional variance of score per bucket (only when include_variance was requested)."
},
"withoutLabel": {
"type": "integer",
"title": "Withoutlabel",
"description": "The number of proofpoints that are missing the aggregation field (e.g. founded_on).",
"default": 0
}
},
"type": "object",
"required": [
"labels",
"counts"
],
"title": "TimeSeries",
"description": "A simple time series, aggregating information per time bucket."
},
"TopicScoreMultiplier": {
"properties": {
"type": {
"type": "string",
"const": "topic",
"title": "Type",
"default": "topic"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids"
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields"
},
"fieldWeights": {
"$ref": "#/components/schemas/WeightedFields"
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicScoreMultiplier"
},
"TopicsFilter": {
"properties": {
"type": {
"type": "string",
"const": "topics",
"title": "Type",
"default": "topics"
},
"ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ids",
"description": "Topic ids to filter by."
},
"fields": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__query__index_search_filters__QueryableContentField"
},
"type": "array",
"title": "Fields",
"description": "Maps to topics__title, topics__summary, topics__body, or topics. Use Document for topics."
},
"loadChildren": {
"type": "boolean",
"title": "Loadchildren",
"description": "If True, resolve child topic ids from Neo4j (HAS_CHILD_TOPIC) and filter by ids + all descendants.",
"default": false
}
},
"type": "object",
"required": [
"ids"
],
"title": "TopicsFilter",
"description": "Filter by topic ids (terms on topics or topics__*)."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WeightedFields": {
"properties": {
"title": {
"type": "number",
"title": "Title",
"default": 1
},
"summary": {
"type": "number",
"title": "Summary",
"default": 0.5
},
"body": {
"type": "number",
"title": "Body",
"default": 0.25
}
},
"type": "object",
"title": "WeightedFields",
"description": "Per-field weights for title/summary/body style contributions."
},
"WorkTypes": {
"type": "string",
"enum": [
"article",
"book",
"book-chapter",
"book-review",
"conference-abstract",
"conference-paper",
"data-paper",
"dataset",
"dissertation",
"editorial",
"erratum",
"letter",
"libguides",
"other",
"paratext",
"peer-review",
"preprint",
"reference-entry",
"report",
"retraction",
"review",
"software",
"software-paper",
"standard",
"supplementary-materials"
],
"title": "WorkTypes",
"description": "OpenAlex work type vocabulary. Values match https://developers.openalex.org/api-reference/work-types."
},
"event_models__core_models__page__Page_Project___1": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__indexed_document_search__core__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__core_models__page__Page_Project___2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/event_models__proof_points__project__Project"
},
"type": "array",
"title": "Data",
"description": "The data for the page."
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total",
"description": "The total number of results, returned only if requested."
}
},
"type": "object",
"required": [
"data"
],
"title": "Page[Project]"
},
"event_models__facts__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink"
},
"event_models__facts__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink"
},
"event_models__indexed_document_search__core__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedTopics"
},
{
"type": "null"
}
]
},
"parentGpes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedParentGpes"
},
{
"type": "null"
}
]
},
"nodes": {
"anyOf": [
{
"$ref": "#/components/schemas/DetectedNodes"
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"relex": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Relex"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
},
"event_models__indexed_document_search__core__queryable_content_field__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField"
},
"event_models__indexed_document_search__query__index_search_filters__QueryableContentField": {
"type": "string",
"enum": [
"title",
"summary",
"body",
"document"
],
"title": "QueryableContentField",
"description": "Content fields for full-text and topic filters. Document = all of title, summary, body."
},
"event_models__indicators__acquisition__acquisition_topic_link__AcquisitionTopicLink": {
"type": "string",
"enum": [
"acquirer",
"acquiree",
"both"
],
"title": "AcquisitionTopicLink",
"description": "Filters on the link between the organization involved in the acquisition and the topic."
},
"event_models__indicators__investment__investment_topic_link__InvestmentTopicLink": {
"type": "string",
"enum": [
"investor",
"investee",
"both"
],
"title": "InvestmentTopicLink",
"description": "Filters on the link between the organization involved in the investment and the topic."
},
"event_models__proof_points__project__Project": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/IdNameModel"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Publishedat"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageCodes"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"topics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topics"
},
"topicsTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicstitle"
},
"topicsSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicssummary"
},
"topicsBody": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Topicsbody"
},
"parentGpes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpes"
},
"parentGpesTitle": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpestitle"
},
"parentGpesSummary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parentgpessummary"
},
"acquisitionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acquisitionnodes"
},
"cityNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Citynodes"
},
"countryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Countrynodes"
},
"gpeNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Gpenodes"
},
"investmentNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Investmentnodes"
},
"mergerNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mergernodes"
},
"orgNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Orgnodes"
},
"partnershipNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Partnershipnodes"
},
"settlementNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Settlementnodes"
},
"subCountryNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Subcountrynodes"
},
"worldRegionNodes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/IdNameModel"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Worldregionnodes"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status",
"description": "Status of the project (ongoing, closed, grant agreement terminated) "
},
"acronym": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Acronym",
"description": "Project acronym (based on title for cordis) "
},
"program": {
"anyOf": [
{
"$ref": "#/components/schemas/ProjectTypes"
},
{
"type": "null"
}
],
"description": "The project program, for cordis e.g. Horizon2020,FP7, etc."
},
"cordisEcContribution": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cordiseccontribution",
"description": "Maximum amount for EU funding (commitment) "
},
"cordisGrantDoi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cordisgrantdoi",
"description": "Each project (from H2020 onwards) is attributed a Digital Object Identifier (DOI) "
},
"endDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Enddate",
"description": "End date of the project "
},
"startDate": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Startdate",
"description": "Start date of the project "
},
"totalCost": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Totalcost",
"description": "Amount of money invested in the project in total. The total cost is expressed in euro.\nFor cordis: The total cost includes EU contribution as well as other project costs not covered by EU funding. "
}
},
"type": "object",
"title": "Project"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"tags": [
{
"name": "Indicators",
"description": "Deprecated. Prefer Proof Points, Facts, or Manifestations endpoints instead."
},
{
"name": "Manifestations",
"description": "Grouped manifestations derived from proof points and knowledge-graph facts."
},
{
"name": "Proof Points",
"description": "Enriched document proof points derived from indexed documents."
},
{
"name": "Topics",
"description": "A structured taxonomy with parent-child relationships, containing for example trends."
}
],
"externalDocs": {
"description": "docs",
"url": "https://connect.trendtracker.ai/"
},
"servers": [
{
"url": "https://connect-api.trendtracker.ai",
"description": "Trendtracker Connect API"
}
]
}